Viewport resolution scale parameter 2 by christianstamati · Pull Request #759 · EpicGamesExt/PixelStreamingInfrastructure

christianstamati · 2026-01-13T20:45:02Z

Relevant components:

Problem statement:

When connecting from an iPhone or small screen device with MatchViewportRes set to true, the rendered resolution appears quite low, causing the visuals to look slightly pixelated.

More info here: #721

Solution

Added a new numeric parameter ViewportResolutionScale that multiplies the resolution dimensions sent to the onMatchViewportResolutionCallback when MatchViewportResolution is enabled. The scale factor is applied to both width and height in VideoPlayer.updateVideoStreamSize(), allowing users to request higher resolution streams (e.g., 1.5x or 2.0x) to improve visual quality on small screens.

Documentation

The new ViewportResolutionScale parameter is documented in Frontend/Docs/Settings Panel.md under the UI section.

Test Plan and Compatibility

Existing unit tests: Config.test.ts automatically covers the new parameter via the "should populate initial values for all settings" test (line 42-49), which validates all numeric parameters are registered

…l.md

…ameter

changeset-bot · 2026-01-13T20:45:06Z

🦋 Changeset detected

Latest commit: 1d0d804

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.7	Minor
@epicgames-ps/lib-pixelstreamingfrontend-ue5.7	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

lukehb

Thanks for the PR!

We ran this through some QA and I have left a few comments about what we would like changed before we can merge this.

In addition to those suggestions below we would also like:

The new setting to be exposed to the UI by modifying something like this (untested, please verify):

if (isSectionEnabled(settingsConfig, SettingsSections.UI)) {
    /* Setup all view/ui related settings under this section */
    const viewSettingsSection = this.buildSectionWithHeading(settingsElem, SettingsSections.UI);
    if (isSettingEnabled(settingsConfig, Flags.MatchViewportResolution))
        this.addSettingFlag(viewSettingsSection, this.flagsUi.get(Flags.MatchViewportResolution));

    // Your new setting here
    if (isSettingEnabled(settingsConfig, NumericParameters.ViewportResolutionScale))
        this.addSettingNumeric(viewSettingsSection, NumericParameters.ViewportResolutionScale);
        
    // ... Other view settings
}

A changeset added with accompanying long form change log entry, see: #759 (comment) for how to make a changset - When you make the changeset, it will be a minor change bump to both the library and UI library packages.

lukehb · 2026-01-14T03:30:30Z

+                'Viewport Resolution Scale',
+                'Scale factor for viewport resolution when MatchViewportResolution is enabled. 1.0 = 100%, 0.5 = 50%, 2.0 = 200%.',
+                0.1 /*min*/,
+                10.0 /*max*/,


We did some QA on this and we think 3x is a sane maximum. Values above that will commonly cause the encoder to fail as this will exceed the maximum encoding size on our H.264 settings - e.g. 4096x4096.

Suggested change

10.0 /*max*/,

3.0 /*max*/,

lukehb · 2026-01-14T03:36:37Z

@@ -31,6 +31,7 @@ This page will be updated with new features and commands as they become availabl
 | **Setting** | **Description** |
 | --- | --- |
 | **Match viewport resolution** | Resizes the Unreal Engine application resolution to match the browser's video element size.|


Suggested change

| **Match viewport resolution** | Resizes the Unreal Engine application resolution to match the browser's video element size.|

| **Match Viewport Resolution** | Resizes the Unreal Engine application resolution to match the browser's video element size. (Note: We recommend using `-windowed` on the UE side to allow scaling beyond monitor size.)|

lukehb · 2026-01-14T03:37:47Z

 | **Setting** | **Description** |
 | --- | --- |
 | **Match viewport resolution** | Resizes the Unreal Engine application resolution to match the browser's video element size.|
+| **Viewport Resolution Scale** | Scale factor for viewport resolution when Match Viewport Resolution is enabled. Range: 0.1-10.0, Default: 1.0. Values above 1.0 (e.g., 1.5, 2.0) can improve visual quality on small screens by requesting higher resolution streams. |


Suggested change

| **Viewport Resolution Scale** | Scale factor for viewport resolution when Match Viewport Resolution is enabled. Range: 0.1-10.0, Default: 1.0. Values above 1.0 (e.g., 1.5, 2.0) can improve visual quality on small screens by requesting higher resolution streams. |

| **Viewport Resolution Scale** | Scale factor for viewport resolution when Match Viewport Resolution is enabled. Range: 0.1-3.0, Default: 1.0 (no scaling). Values above 1.0 (e.g., 1.5, 2.0) can improve visual quality on small screens by requesting higher resolution streams. |

…ameter

christianstamati · 2026-01-17T20:42:45Z

Hi @lukehb,
I've addressed all the changes here. The ViewportResolutionScale setting is now configured and positioned under MatchViewportResolution as requested.
However, after adding the code at ConfigUI.ts (206-210), building everything, and launching the SignalingServer, I don't see the option in the player UI. Could you help troubleshoot why it's not appearing?
Thanks!

Belchy06 · 2026-02-09T01:19:17Z

Hey @christianstamati,

You might have a bad local state.

I was able to build this branch and run the signalling server by running ./SignallingWebServer/platform_scripts/cmd/start.bat --build and after a page refresh I can see the UI element displaying.

…e constant - Round scaled dimensions to integers before sending Resolution.Width / Height commands to UE (non-integers were being JSON-stringified and handed to cvar parsing). - Warn via Logger when a scaled dimension exceeds the H.264 4096 limit so large viewports with high scales surface a clear encoding-failure hint. - Rename NumericParameters.ViewportResolutionScale -> ViewportResScale so the TS constant matches the URL-param / persisted key ('ViewportResScale'). - Add Config.hasNumericSetting and fall back to 1.0 in VideoPlayer when the setting is absent, so custom Config subclasses do not throw on every resize. - Add VideoPlayer Jest coverage for default, scaled, rounded, >4096-warn, within-limit, missing-setting-fallback, and flag-disabled paths.

github-actions · 2026-04-23T02:13:44Z

💔 Some backports could not be created

Status	Branch	Result
❌	UE5.5	Backport failed because of merge conflicts
❌	UE5.6	Backport failed because of merge conflicts
✅	UE5.7

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 759

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

mcottontensor · 2026-04-23T02:26:16Z

💚 All backports created successfully

Status	Branch	Result
✅	UE5.6

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

mcottontensor · 2026-04-23T02:27:15Z

💚 All backports created successfully

Status	Branch	Result
✅	UE5.5

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

* Viewport resolution scale parameter 2 (#759) * Add ViewportResolutionScale configuration parameter * Add Docs for Viewport Resolution Scale in Frontend/Docs/Settings Panel.md * Address PR feedback: improve ViewportResolutionScale configuration * Harden ViewportResScale: round output, warn past encoder limit, rename constant - Round scaled dimensions to integers before sending Resolution.Width / Height commands to UE (non-integers were being JSON-stringified and handed to cvar parsing). - Warn via Logger when a scaled dimension exceeds the H.264 4096 limit so large viewports with high scales surface a clear encoding-failure hint. - Rename NumericParameters.ViewportResolutionScale -> ViewportResScale so the TS constant matches the URL-param / persisted key ('ViewportResScale'). - Add Config.hasNumericSetting and fall back to 1.0 in VideoPlayer when the setting is absent, so custom Config subclasses do not throw on every resize. - Add VideoPlayer Jest coverage for default, scaled, rounded, >4096-warn, within-limit, missing-setting-fallback, and flag-disabled paths. --------- Co-authored-by: Matthew.Cotton <matt@tensorworks.com.au> (cherry picked from commit 60da95c) # Conflicts: # Frontend/library/src/VideoPlayer/VideoPlayer.ts * fix: fixing ue version reference. --------- Co-authored-by: Christian Stamati <hello@chri.dev>

* Viewport resolution scale parameter 2 (#759) * Add ViewportResolutionScale configuration parameter * Add Docs for Viewport Resolution Scale in Frontend/Docs/Settings Panel.md * Address PR feedback: improve ViewportResolutionScale configuration * Harden ViewportResScale: round output, warn past encoder limit, rename constant - Round scaled dimensions to integers before sending Resolution.Width / Height commands to UE (non-integers were being JSON-stringified and handed to cvar parsing). - Warn via Logger when a scaled dimension exceeds the H.264 4096 limit so large viewports with high scales surface a clear encoding-failure hint. - Rename NumericParameters.ViewportResolutionScale -> ViewportResScale so the TS constant matches the URL-param / persisted key ('ViewportResScale'). - Add Config.hasNumericSetting and fall back to 1.0 in VideoPlayer when the setting is absent, so custom Config subclasses do not throw on every resize. - Add VideoPlayer Jest coverage for default, scaled, rounded, >4096-warn, within-limit, missing-setting-fallback, and flag-disabled paths. --------- Co-authored-by: Matthew.Cotton <matt@tensorworks.com.au> (cherry picked from commit 60da95c) # Conflicts: # Frontend/library/src/VideoPlayer/VideoPlayer.ts * fix: fixing ue version references. --------- Co-authored-by: Christian Stamati <hello@chri.dev>

* Add ViewportResolutionScale configuration parameter * Add Docs for Viewport Resolution Scale in Frontend/Docs/Settings Panel.md * Address PR feedback: improve ViewportResolutionScale configuration * Harden ViewportResScale: round output, warn past encoder limit, rename constant - Round scaled dimensions to integers before sending Resolution.Width / Height commands to UE (non-integers were being JSON-stringified and handed to cvar parsing). - Warn via Logger when a scaled dimension exceeds the H.264 4096 limit so large viewports with high scales surface a clear encoding-failure hint. - Rename NumericParameters.ViewportResolutionScale -> ViewportResScale so the TS constant matches the URL-param / persisted key ('ViewportResScale'). - Add Config.hasNumericSetting and fall back to 1.0 in VideoPlayer when the setting is absent, so custom Config subclasses do not throw on every resize. - Add VideoPlayer Jest coverage for default, scaled, rounded, >4096-warn, within-limit, missing-setting-fallback, and flag-disabled paths. --------- (cherry picked from commit 60da95c) Co-authored-by: Christian Stamati <hello@chri.dev> Co-authored-by: Matthew.Cotton <matt@tensorworks.com.au>

christianstamati and others added 3 commits November 25, 2025 22:51

Add ViewportResolutionScale configuration parameter

13cefae

Add Docs for Viewport Resolution Scale in Frontend/Docs/Settings Pane…

a485192

…l.md

Merge branch 'EpicGamesExt:master' into viewport-resolution-scale-par…

014daf7

…ameter

christianstamati mentioned this pull request Jan 13, 2026

Is it possible to increase the viewport resolution while keeping MatchViewportRes set to true? #721

Closed

7 tasks

lukehb requested changes Jan 14, 2026

View reviewed changes

Belchy06 added the never-stale label Jan 14, 2026

christianstamati and others added 2 commits January 17, 2026 20:18

Merge branch 'EpicGamesExt:master' into viewport-resolution-scale-par…

12ccc2f

…ameter

Address PR feedback: improve ViewportResolutionScale configuration

a568f6a

mcottontensor added auto-backport Used to specify we want a PR to auto backport to a branch, must be paired with auto-backport-to-UEX. auto-backport-to-UE5.5 auto-backport-to-UE5.6 auto-backport-to-UE5.7 labels Apr 23, 2026

mcottontensor merged commit 60da95c into EpicGamesExt:master Apr 23, 2026
8 checks passed

github-actions Bot mentioned this pull request Apr 23, 2026

[UE5.7] Viewport resolution scale parameter 2 (#759) #808

Merged

mcottontensor mentioned this pull request Apr 23, 2026

[UE5.6] Viewport resolution scale parameter 2 (#759) #809

Merged

mcottontensor mentioned this pull request Apr 23, 2026

[UE5.5] Viewport resolution scale parameter 2 (#759) #810

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Viewport resolution scale parameter 2#759

Viewport resolution scale parameter 2#759
mcottontensor merged 6 commits intoEpicGamesExt:masterfrom
christianstamati:viewport-resolution-scale-parameter

christianstamati commented Jan 13, 2026

Uh oh!

changeset-bot Bot commented Jan 13, 2026 •

edited

Loading

Uh oh!

lukehb left a comment •

edited

Loading

Uh oh!

lukehb Jan 14, 2026

Uh oh!

lukehb Jan 14, 2026

Uh oh!

lukehb Jan 14, 2026

Uh oh!

christianstamati commented Jan 17, 2026

Uh oh!

Belchy06 commented Feb 9, 2026

Uh oh!

Uh oh!

github-actions Bot commented Apr 23, 2026

Uh oh!

mcottontensor commented Apr 23, 2026

Uh oh!

mcottontensor commented Apr 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	\| Match viewport resolution \| Resizes the Unreal Engine application resolution to match the browser's video element size.\|
	\| Match Viewport Resolution \| Resizes the Unreal Engine application resolution to match the browser's video element size. (Note: We recommend using `-windowed` on the UE side to allow scaling beyond monitor size.)\|

	\| Viewport Resolution Scale \| Scale factor for viewport resolution when Match Viewport Resolution is enabled. Range: 0.1-10.0, Default: 1.0. Values above 1.0 (e.g., 1.5, 2.0) can improve visual quality on small screens by requesting higher resolution streams. \|
	\| Viewport Resolution Scale \| Scale factor for viewport resolution when Match Viewport Resolution is enabled. Range: 0.1-3.0, Default: 1.0 (no scaling). Values above 1.0 (e.g., 1.5, 2.0) can improve visual quality on small screens by requesting higher resolution streams. \|

Conversation

christianstamati commented Jan 13, 2026

Relevant components:

Problem statement:

Solution

Documentation

Test Plan and Compatibility

Uh oh!

changeset-bot Bot commented Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

lukehb left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lukehb Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

lukehb Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

lukehb Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

christianstamati commented Jan 17, 2026

Uh oh!

Belchy06 commented Feb 9, 2026

Uh oh!

Uh oh!

github-actions Bot commented Apr 23, 2026

💔 Some backports could not be created

Manual backport

Questions ?

Uh oh!

mcottontensor commented Apr 23, 2026

💚 All backports created successfully

Questions ?

Uh oh!

mcottontensor commented Apr 23, 2026

💚 All backports created successfully

Questions ?

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

changeset-bot Bot commented Jan 13, 2026 •

edited

Loading

lukehb left a comment •

edited

Loading